

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

<html>
<head>
<script type="text/javascript" src="helpman_topicinit.js"></script>

<title>EA_GetMenuItems [Enterprise Architect User Guide]</title>

<meta name="keywords" content="Enterprise Architect, Sparx Systems, UML, Add-In Model,Add-In Model EA_GetMenuItems,Add-In Model Add-In Event, EA_GetMenuItems,Add-In Event,Add-In Event EA_GetMenuItems,EA_GetMenuItems,EA_GetMenuItems Add-In Event">
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
<meta http-equiv="Content-Style-Type" content="text/css" />

<link type="text/css" href="default.css" rel="stylesheet" />
<style type="text/css">
  A, A:Visited
  {
    color: #00F;
  }

  A:Active, A:Hover
  {
    color: #F00;
  }

  OL
  {
    margin: 5px 0 5px 48px;
  }

  UL
  {
    margin-bottom: 3px;
    margin-top: 0;
  }

  #nsr
  {
    background-color: #D4DFFF;
  }

  #nsr A
  {
    text-decoration: none;
  }

  #mainbody
  {
    padding: 8px;
  }

  .p_BodyText
  {
    padding: 5px 0;
  }
</style>



<style type="text/css" media="screen">
  BODY
  {
    background-color: #FFFFFF;
  }

  #nsr
  {
    padding: 6px 6px 0 6px;
    border-bottom: none;
    vertical-align: top;
    z-index: 2;
    visibility: visible;
    left: 0;
    top: 0;
    position: absolute;
  }

  #mainbody
  {
    left: 0;
    top: 0;
    margin: 0;
    position: absolute;
    padding: 10px;
    overflow: auto;
    height: 100%;
    z-index: 1;
    background-repeat: no-repeat;
    background-position: bottom right;
    background-attachment: fixed;
  }
</style>

<style type="text/css" media="print">
  #nsr
  {
    visibility: none;
  }

  #mainbody
  {
    overflow: visible;
  }
</style>
<script type="text/javascript" language="JavaScript" src="nonscroll.js"></script>

</head>
<body scroll="no">

<div id="page">



        <div id="content">
          <div id="content-inner">
          



  
          <div id="nsr">
            <table border="0" cellspacing="0" cellpadding="4" width="100%">
              <tr valign="top">
                <td align="left">
  


                  <p class="p_Heading1"><span class="f_Heading1">EA_GetMenuItems</span></p>



  
                </td>
                <td align="right">
                  <a href="introduction.htm" onmouseover="document.images.main.src='button_main_h.gif'" onmouseout="document.images.main.src='button_main.gif'">
                    <img name="main" src="button_main.gif" border=0 alt="Return to Introduction">
                  </a>&nbsp;
    
                  <a href="eaadd_insea_disconnect.htm" onmouseover="document.images.prev.src='button_prev_h.gif'" onmouseout="document.images.prev.src='button_prev.gif'">
                    <img name=prev src="button_prev.gif" border=0 alt="Previous page" />
                  </a>&nbsp;
    
    
    
                  <a href="eaadd_insea_getmenustate.htm" onmouseover="document.images.next.src='button_next_h.gif'" onmouseout="document.images.next.src='button_next.gif'">
                    <img name=next src="button_next.gif" border=0 alt="Next page" />
                  </a>
    
    
                </td>
              </tr>
            </table>
          </div>
          <div id="mainbody">
  


                <p class="p_SubHeadingL1"><span class="f_SubHeadingL1">Details</span></p>
<p class="p_BodyText"><span class="f_BodyText">The </span><span class="f_BodyText" style="font-style: italic;">EA_GetMenuItems</span><span class="f_BodyText"> event enables the Add-In to provide the Enterprise Architect user interface with additional Add-In menu options in various context and main menus. When a user selects an Add-In menu option, an event is raised and passed back to the Add-In that originally defined that menu option.</span></p>
<p class="p_BodyText"><span class="f_BodyText">This event is raised just before Enterprise Architect has to show particular menu options to the user, and its use is described in the </span><span class="f_BodyText" style="font-style: italic;"><a href="definingmenuitems.htm">Define Menu Items</a></span><span class="f_BodyText"> topic.</span></p>
<p class="p_BodyText"><span class="f_BodyText">Also look at:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1" style="font-style: italic;"><a href="eaadd_insea_menuclick.htm">EA_MenuClick</a></span></li>
<li><span class="f_Bulletlist1" style="font-style: italic;"><a href="eaadd_insea_getmenustate.htm">EA_GetMenuState</a></span><span class="f_Bulletlist1">.</span></li>
</ul>
<p class="p_SubHeadingL1"><span class="f_SubHeadingL1">Syntax</span></p>
<p class="p_BodyText"><span class="f_BodyText" style="font-style: italic; font-weight: bold;">Function </span><span class="f_BodyText" style="font-weight: bold;"> </span><span class="f_BodyText" style="font-weight: bold;">EA_GetMenuItems</span><span class="f_BodyText" style="font-style: italic; font-weight: bold;">(Repository As EA.Repository, MenuLocation As String, MenuName As String) As Variant</span></p>
<p class="p_BodyText"><span class="f_BodyText">The</span><span class="f_BodyText" style="font-style: italic;"> EA_GetMenuItems</span><span class="f_BodyText"> function syntax has the following elements:</span></p>
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 5px 0px 5px 13px;"><table cellspacing="0" cellpadding="0" border="0" style="border: none; border-spacing:0px; border-collapse: collapse;">
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="96" bgcolor="#e3e6ed" style="width:96px; background-color:#e3e6ed; border: solid 1px #000000;"><p class="p_Tableheader"><span class="f_Tableheader">Parameter</span></p>
</td>
<td valign="top" width="94" bgcolor="#e3e6ed" style="width:94px; background-color:#e3e6ed; border: solid 1px #000000;"><p class="p_Tableheader"><span class="f_Tableheader">Type</span></p>
</td>
<td valign="top" width="66" bgcolor="#e3e6ed" style="width:66px; background-color:#e3e6ed; border: solid 1px #000000;"><p class="p_Tableheader"><span class="f_Tableheader">Direction</span></p>
</td>
<td valign="top" width="424" bgcolor="#e3e6ed" style="width:424px; background-color:#e3e6ed; border: solid 1px #000000;"><p class="p_Tableheader"><span class="f_Tableheader">Description</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="96" style="width:96px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">MenuLocation</span></p>
</td>
<td valign="top" width="94" style="width:94px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">String</span></p>
</td>
<td valign="top" width="66" style="width:66px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">&nbsp;</span></p>
</td>
<td valign="top" width="424" style="width:424px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">String representing the part of the user interface that brought up the menu. Can be </span><span class="f_Tabletext" style="font-style: italic;">TreeView</span><span class="f_Tabletext">, </span><span class="f_Tabletext" style="font-style: italic;">MainMenu</span><span class="f_Tabletext"> or </span><span class="f_Tabletext" style="font-style: italic;">Diagram</span><span class="f_Tabletext">.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="96" style="width:96px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">MenuName</span></p>
</td>
<td valign="top" width="94" style="width:94px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">String</span></p>
</td>
<td valign="top" width="66" style="width:66px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">&nbsp;</span></p>
</td>
<td valign="top" width="424" style="width:424px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">The name of the parent menu for which sub-items are to be defined. In the case of the top-level menu it is an empty string.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="96" style="width:96px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Repository</span></p>
</td>
<td valign="top" width="94" style="width:94px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;"><a href="repository3.htm">EA.Repository</a></span></p>
</td>
<td valign="top" width="66" style="width:66px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">IN</span></p>
</td>
<td valign="top" width="424" style="width:424px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">An EA.Repository object representing the currently open Enterprise Architect model. Poll its members to retrieve model data and user interface status information.</span></p>
</td>
</tr>
</table>
</div>
<p class="p_SubHeadingL1"><span class="f_SubHeadingL1">Return Value</span></p>
<p class="p_BodyText"><span class="f_BodyText">One of the following types:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">A string indicating the label for a single menu option.</span></li>
<li><span class="f_Bulletlist1">An array of strings indicating a multiple menu options.</span></li>
<li><span class="f_Bulletlist1">Empty (Visual Basic/VB.NET) or null (C#) to indicate that no menu should be displayed.</span></li>
</ul>
<p class="p_BodyText"><span class="f_BodyText">In the case of the top-level menu it should be a single string or an array containing only one item, or Empty/null.</span></p>




            </div>
          </div>
        </div>



</div>


</body>
</html>
